// --------------------------------------------------------------------------------------------------------------------
// <copyright file="VerifyNameInControlMessageAgent.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------

namespace Test.Robotics.Runtime
{
    using System.Runtime.Serialization;
    using System.Threading;
    using Microsoft.Robotics.Runtime;
    using Microsoft.VisualStudio.TestTools.UnitTesting;

    /// <summary>
    /// An agent used to verify that the OriginatingAgentName property is correctly set in control messages
    /// </summary>
    [DataContract]
    [System.Diagnostics.CodeAnalysis.SuppressMessage(
    "Microsoft.Design",
    "CA1001:TypesThatOwnDisposableFieldsShouldBeDisposable",
    Justification = "Agents clean up resources when OnDeactivated() is called")]
    public class VerifyNameInControlMessageAgent : Agent,
                             IControlReceiver<SimpleAgentMessage<int>>
    {
        /// <summary>
        /// Used to ensure that message was received before a test exits.
        /// </summary>
        private ManualResetEvent receiveMessageEvent;

        /// <summary>
        /// The originatingAgentName property from the most recent control message received.
        /// </summary>
        private string originatingAgentNameInLastControlMessage;

        /// <summary>
        /// Initializes a new instance of the <see cref="VerifyNameInControlMessageAgent"/> class.
        /// </summary>
        /// <param name="name">The name of the agent instance.</param>
        public VerifyNameInControlMessageAgent(string name)
            : base(name)
        {
            this.receiveMessageEvent = new ManualResetEvent(false);
        }

        /// <summary>
        /// Called to process control messages of this type.
        /// </summary>
        /// <param name="message">Control message</param>
        public void ReceiveControl(SimpleAgentMessage<int> message)
        {
            this.originatingAgentNameInLastControlMessage = message.CreatingAgentName;
            this.receiveMessageEvent.Set();
        }

        /// <summary>
        /// Wait for a control message to be received.
        /// </summary>
        /// <returns> Originating agent name for the most recently received control message. </returns>
        public string GetOriginatingNameInControlMessage()
        {
            this.receiveMessageEvent.WaitOne();
            this.receiveMessageEvent.Reset();
            return this.originatingAgentNameInLastControlMessage;
        }
    }
}
